feat: add CLAUDE.md for AI-assisted development#818
Closed
frostebite wants to merge 2 commits intomainfrom
Closed
Conversation
Adds a minimal CLAUDE.md covering project architecture, build system, code conventions, testing, security considerations, and CI workflows. Provides Claude Code with the context needed to assist with builds, debugging, orchestrator work, and contributions. Closes #801 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
📝 WalkthroughWalkthroughAdded a new Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #818 +/- ##
=======================================
Coverage 31.25% 31.25%
=======================================
Files 84 84
Lines 4563 4563
Branches 1103 1103
=======================================
Hits 1426 1426
Misses 3137 3137
🚀 New features to boost your workflow:
|
Member
|
Recommend watching this one https://www.youtube.com/watch?v=GcNu6wrLTJc (i.e. strip most of that stuff even) And shall we link CLAUDE.md to AGENTS.md and make AGENTS.md the main file? |
The orchestrator-develop branch no longer exists. Update all fallback clone commands and test fixtures to use main instead. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/orchestrator-async-checks.yml:
- Around line 56-58: The git clone step currently always checks out main; update
the run block that contains the "git clone -b main
https://github.com/game-ci/unity-builder" command so it first attempts to check
out the dispatched workflow ref and only falls back to main if that ref is
missing. Use the workflow-provided ref (e.g. the github.ref or github.sha) by
deriving the branch name or committing ref (e.g. ${GITHUB_REF##refs/heads/} or
using ${GITHUB_SHA}) and run git clone then git fetch && git checkout <ref> (or
replace the manual clone with actions/checkout and set ref: ${{ github.ref }}),
ensuring the step that currently contains "git clone -b main
https://github.com/game-ci/unity-builder" and "cd unity-builder" uses the
dispatched ref first.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 86d648de-e7c0-4559-bf25-0db1891c0047
⛔ Files ignored due to path filters (2)
dist/index.jsis excluded by!**/dist/**dist/index.js.mapis excluded by!**/dist/**,!**/*.map
📒 Files selected for processing (4)
.github/workflows/orchestrator-async-checks.ymlsrc/model/orchestrator/tests/e2e/orchestrator-end2end-caching.test.tssrc/model/orchestrator/workflows/async-workflow.tssrc/model/orchestrator/workflows/build-automation-workflow.ts
✅ Files skipped from review due to trivial changes (1)
- src/model/orchestrator/tests/e2e/orchestrator-end2end-caching.test.ts
Comment on lines
56
to
58
| run: | | ||
| git clone -b orchestrator-develop https://github.com/game-ci/unity-builder | ||
| git clone -b main https://github.com/game-ci/unity-builder | ||
| cd unity-builder |
There was a problem hiding this comment.
Clone the dispatched ref before falling back to main.
workflow_dispatch can run from a feature branch, but this always pulls main, so checks-update ignores the branch the workflow was launched from. That makes branch-specific orchestrator changes impossible to validate here.
Suggested fix
- git clone -b main https://github.com/game-ci/unity-builder
+ git clone -b "${GITHUB_REF_NAME:-main}" https://github.com/game-ci/unity-builder \
+ || git clone -b main https://github.com/game-ci/unity-builder📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| run: | | |
| git clone -b orchestrator-develop https://github.com/game-ci/unity-builder | |
| git clone -b main https://github.com/game-ci/unity-builder | |
| cd unity-builder | |
| run: | | |
| git clone -b "${GITHUB_REF_NAME:-main}" https://github.com/game-ci/unity-builder \ | |
| || git clone -b main https://github.com/game-ci/unity-builder | |
| cd unity-builder |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/workflows/orchestrator-async-checks.yml around lines 56 - 58, The
git clone step currently always checks out main; update the run block that
contains the "git clone -b main https://github.com/game-ci/unity-builder"
command so it first attempts to check out the dispatched workflow ref and only
falls back to main if that ref is missing. Use the workflow-provided ref (e.g.
the github.ref or github.sha) by deriving the branch name or committing ref
(e.g. ${GITHUB_REF##refs/heads/} or using ${GITHUB_SHA}) and run git clone then
git fetch && git checkout <ref> (or replace the manual clone with
actions/checkout and set ref: ${{ github.ref }}), ensuring the step that
currently contains "git clone -b main https://github.com/game-ci/unity-builder"
and "cd unity-builder" uses the dispatched ref first.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CLAUDE.mdcovering project architecture, build system, code conventions, testing, security, and CI workflowsCloses
Closes #801
Test plan
CLAUDE.mdrenders correctly on GitHub🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores